<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArMapInterface.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ArMapInterface_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">ArMapInterface.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Contains the set of interfaces that define the <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;ariaTypedefs.h&quot;</code><br />
<code>#include &quot;ariaUtil.h&quot;</code><br />
<code>#include &quot;ArMapObject.h&quot;</code><br />
<code>#include &quot;ArMapUtils.h&quot;</code><br />
<code>#include &quot;ArArgumentBuilder.h&quot;</code><br />
<code>#include &quot;ArFunctor.h&quot;</code><br />
<code>#include &quot;ArHasFileName.h&quot;</code><br />
<code>#include &quot;ArMutex.h&quot;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;set&gt;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInfoInterface.html">ArMapInfoInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Methods related to setting and retrieving the various "info" tags in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  <a href="classArMapInfoInterface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapInterface.html">ArMapInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classArMapInterface.html" title="ArMapInterface defines the methods that are available on all Aria maps. ">ArMapInterface</a> defines the methods that are available on all <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps.  <a href="classArMapInterface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapObjectsInterface.html">ArMapObjectsInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Methods related to setting and retrieving the objects in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  <a href="classArMapObjectsInterface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapScanInterface.html">ArMapScanInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Methods related to setting and retrieving the scan-related data in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  <a href="classArMapScanInterface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArMapSupplementInterface.html">ArMapSupplementInterface</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Methods related to miscellaneous extra data in an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map.  <a href="classArMapSupplementInterface.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac9bfc47ae45cd704d0c287fa69f56686"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9bfc47ae45cd704d0c287fa69f56686"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ArMapInterface_8h.html#ac9bfc47ae45cd704d0c287fa69f56686">ARMAP_DEFAULT_SCAN_TYPE</a>&#160;&#160;&#160;&quot;&quot;</td></tr>
<tr class="memdesc:ac9bfc47ae45cd704d0c287fa69f56686"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default scan type indicator, when an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map only has obstacle data of one type. <br /></td></tr>
<tr class="separator:ac9bfc47ae45cd704d0c287fa69f56686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad81fb545e96e45e92a2065b7fdfe02c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad81fb545e96e45e92a2065b7fdfe02c0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ArMapInterface_8h.html#ad81fb545e96e45e92a2065b7fdfe02c0">ARMAP_SUMMARY_SCAN_TYPE</a>&#160;&#160;&#160;NULL</td></tr>
<tr class="memdesc:ad81fb545e96e45e92a2065b7fdfe02c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The scan type indicator used to obtain collective data from most or all obstacle data (see individual methods for how it is used for specific kinds of map data) <br /></td></tr>
<tr class="separator:ad81fb545e96e45e92a2065b7fdfe02c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Contains the set of interfaces that define the <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps. </p>
<dl class="section date"><dt>Date</dt><dd>06/27/08 </dd></dl>
<dl class="section author"><dt>Author</dt><dd>K. Cunningham</dd></dl>
<p>The methods that define the <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps are grouped into a set of smaller interfaces which are contained in this file. These include:</p>
<ul>
<li><a class="el" href="classArMapScanInterface.html" title="Methods related to setting and retrieving the scan-related data in an Aria map. ">ArMapScanInterface</a> : Methods related to scan data (e.g. points and lines) generally obtained from a specific sensor (such as the SICK laser or Hokuyo URG).</li>
<li><a class="el" href="classArMapObjectsInterface.html" title="Methods related to setting and retrieving the objects in an Aria map. ">ArMapObjectsInterface</a> : Methods related to the objects in a map. These include user-defined objects such as goals, docks, and forbidden lines. They also include special "data" types of objects that may be automatically created during the scanning process.</li>
<li><a class="el" href="classArMapInfoInterface.html" title="Methods related to setting and retrieving the various &quot;info&quot; tags in an Aria map. ...">ArMapInfoInterface</a> : Methods related to the various info arguments stored in a map. Examples of info include the map object type definitions and the routes and macros.</li>
<li><a class="el" href="classArMapSupplementInterface.html" title="Methods related to miscellaneous extra data in an Aria map. ">ArMapSupplementInterface</a> : Methods used to access supplemental data associated with the map. This currently consists only of the latitude / longitude of the origin, but may be extended in the future.</li>
</ul>
<p>The primary interface implemented by all <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> maps is also contained in this file:</p>
<ul>
<li><a class="el" href="classArMapInterface.html" title="ArMapInterface defines the methods that are available on all Aria maps. ">ArMapInterface</a> : All of the methods that are available for an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map. This interface extends all of the above interfaces and contains a few additional file-related methods.</li>
</ul>
<p>In general, when passing an <a class="el" href="classAria.html" title="Contains global initialization, deinitialization and other global functions. ">Aria</a> map (pointer) as a parameter to a method, it is preferable to pass <a class="el" href="classArMapInterface.html" title="ArMapInterface defines the methods that are available on all Aria maps. ">ArMapInterface</a> *. This will allow for extension and different implementations of the interface.</p>
<pre>  
     <a class="el" href="classArMapScanInterface.html" title="Methods related to setting and retrieving the scan-related data in an Aria map. ">ArMapScanInterface</a>
     ^
     |    <a class="el" href="classArMapObjectsInterface.html" title="Methods related to setting and retrieving the objects in an Aria map. ">ArMapObjectsInterface</a>
     |    ^
     |    |    <a class="el" href="classArMapInfoInterface.html" title="Methods related to setting and retrieving the various &quot;info&quot; tags in an Aria map. ...">ArMapInfoInterface</a>
     |    |    ^
     |    |    |    <a class="el" href="classArMapSupplementInterface.html" title="Methods related to miscellaneous extra data in an Aria map. ">ArMapSupplementInterface</a>
     |    |    |    ^  
     |    |    |    | (extends)
     |    |    |    |
      <a class="el" href="classArMapInterface.html" title="ArMapInterface defines the methods that are available on all Aria maps. ">ArMapInterface</a></pre><pre></pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="ArMapInterface_8h.html">ArMapInterface.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
